Skip to content

Latest commit

 

History

History

README.md

Shared Sync Controls

SIK Networking Connected Lenses Sync Kit Multiplayer

shared-sync-controls

Overview

This project showcases a real-time collaborative AR experience where two users adjust a shared numeric value and RGB sliders to control the color of an object in the scene. The system synchronizes all interactions across devices, ensuring seamless collaboration. This lens leverages the Spectacles Interaction Kit (SIK) to simplify UI development for Spectacles and demonstrates the potential of Connected Lenses for creating engaging, synchronized AR experiences.

NOTE: This project will only work for the Spectacles platform.

Design Guidelines

Designing Lenses for Spectacles offers all-new possibilities to rethink user interaction with digital spaces and the physical world. Get started using our Design Guidelines

Prerequisites

  • Lens Studio: v5.15.1+
  • Spectacles OS Version: v5.64+
  • Spectacles App iOS: v0.64+
  • Spectacles App Android: v0.64+

To update your Spectacles device and mobile app, refer to this guide.

You can download the latest version of Lens Studio from here.

Getting the project

To obtain the project folder, you need to clone the repository.

IMPORTANT: This project uses Git Large Files Support (LFS). Downloading a zip file using the green button on Github will not work. You must clone the project with a version of git that has LFS. You can download Git LFS here: https://git-lfs.github.com/.

Initial Project Setup

The project should be pre-configured to get you started without any additional steps. However, if you encounter issues in the Logger Panel, please ensure your Lens Studio environment is set up for Spectacles.

Testing the Lens

In Lens Studio Editor

  1. Open the Lens in Lens Studio and create two Interactive Previews using the Interactive Preview Panel
  2. Click the Multiplayer button for both previews. They will connect to the same session and map surroundings automatically.
  3. Test functionality:
    • Adjust the shared numeric value using the "∧" and "v" buttons in one preview and ensure the change reflects instantly in the second preview.
    • Modify the RGB sliders in one preview and confirm the floating object's color updates in both previews in real-time.

In Spectacles Device

  1. Connect two pairs of Spectacles to the same session following the Playing Connected Lenses Guide.
  2. Test functionality:
    • Adjust the shared numeric value on one device and confirm it updates on the other.
    • Use the RGB sliders on one device and ensure the color of the floating object updates in real-time on both devices.

Key Script

EntryPointMain.ts - This script serves as the entry point for the Lens logic, initializing and managing the execution of other scripts within the project.

Support

If you have any questions or need assistance, please don't hesitate to reach out. Our community is here to help, and you can connect with us and ask for support here. We look forward to hearing from you and are excited to assist you on your journey!

Contributing

Feel free to provide improvements or suggestions or directly contributing via merge request. By sharing insights, you help everyone else build better Lenses.


Built with 👻 by the Spectacles team